Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[Doc] Change the description for pip packages #12584

Merged
merged 4 commits into from
Sep 25, 2018

Conversation

TaoLv
Copy link
Member

@TaoLv TaoLv commented Sep 18, 2018

Description

  • Remove experimental for MKL-DNN backend.
  • Add explaination for pip package name.

@aaronmarkham @pengzhao-intel

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@TaoLv TaoLv requested a review from szha as a code owner September 18, 2018 06:20
@stu1130
Copy link
Contributor

stu1130 commented Sep 18, 2018

Thanks for the contribution @TaoLv
@mxnet-label-bot[pr-awaiting-review]

@marcoabreu marcoabreu added the pr-awaiting-review PR is waiting for code review label Sep 18, 2018

*mxnet-cu92mkl* means the package is built with CUDA/cuDNN and MKL-DNN enabled and the CUDA version is 9.2.

MKL pip package is experimental in some old versions of MXNet.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it be more accurate to say "All MKL pip packages are experimental prior to version x.y.z."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. But I think MKL pip packages should once be GA in some old versions, before it's changed to MKL-DNN backend. @szha May I have your comments?

Copy link
Member

@szha szha Sep 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the pip packages w/ direct mklml integration has always been experimental until being replaced by mkldnn. the USE_MKLML_EXPERIMENTAL flag was on in all of them.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification. Will change the doc.

@vandanavk
Copy link
Contributor

@sandeep-krishnamurthy Please change label to pr-awaiting-merge. This PR has been approved.

@sandeep-krishnamurthy sandeep-krishnamurthy merged commit 769165b into apache:master Sep 25, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants